home *** CD-ROM | disk | FTP | other *** search
/ The Business Master (3rd Edition) / The Business Master (3rd Edition).iso / files / utilstem / anarkey / anarkmd.doc < prev    next >
Text File  |  1989-10-01  |  13KB  |  362 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.                                   ANARKMD
  10.                       The Anarkey Command-Line Utility
  11.                                 User Manual
  12.  
  13.                                 Version 3.00
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32.  
  33.  
  34.  
  35.  
  36.                                 Steven Calwas
  37.                                Moderne Software
  38.                                 P.O. Box 3638
  39.                           Santa Clara, CA 95055-3638
  40.  
  41.  
  42.                               _______
  43.                          ____|__     |               (tm)
  44.                       --|       |    |-------------------
  45.                         |   ____|__  |  Association of
  46.                         |  |       |_|  Shareware
  47.                         |__|   o   |    Professionals
  48.                       -----|   |   |---------------------
  49.                            |___|___|    MEMBER
  50.  
  51.  
  52.  
  53.  
  54.                               Copyright (C) 1989
  55.                                  Steven Calwas
  56.                               All rights reserved
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.  
  71.  
  72.  
  73.  
  74.                                Introduction
  75.                                ------------
  76.  
  77.    ANARKMD (pronounced "anar-command") is a support program for the ANARKEY
  78. software package.  It allows the execution of certain ANARKEY functions to
  79. be instigated from the command line as opposed to the keyboard.  An ANARKEY
  80. function executed via ANARKMD operates exactly as if you had pressed the
  81. associated function invocation keystroke yourself.  In addition, ANARKMD
  82. offers some function enhancements not available when the function is
  83. executed from the keyboard.  For example, a filename and location may be
  84. specified when writing the history buffer contents to a disk file.  With
  85. ANARKMD, ANARKEY functions can be invoked from within a batch file, a
  86. multiple command input line or an AKA.
  87.  
  88.    ANARKMD can also be used to execute an AKA or multiple-command input line
  89. from within a batch file.  Normally, ANARKEY is not active during batch file
  90. processing, but, with ANARKMD, many of the powerful features of ANARKEY will
  91. now be available.
  92.  
  93.  
  94.  
  95.                               Running ANARKMD
  96.                               ---------------
  97.  
  98.    ANARKMD can be executed from the DOS command prompt, within a batch file,
  99. from an AKA or anywhere else a normal program can be run.
  100.  
  101.    The only restriction to ANARKMD execution is that it may NOT be run from
  102. within a multiple command line unless it is the very last command in the
  103. line.  If ANARKMD is run in a multiple command line and other commands
  104. follow it on the line, all the following commands will be ignored; they will
  105. not be executed.
  106.  
  107.    ANARKMD command-line syntax is:
  108.  
  109.         ANARKMD [-option | input_line]
  110.  
  111.    ANARKMD is really two programs combined into one; it can be used to
  112. either:
  113.  
  114.         (1) execute an ANARKEY function or
  115.         (2) execute an entire input line which may contain multiple commands
  116.         and AKAs.
  117.  
  118.    Depending on which operation you wish to perform, either a function
  119. description ("-option") or the line to execute ("input_line") must be
  120. provided to ANARKMD on its command line.  This manual will first discuss how
  121. to invoke an ANARKEY function and then move on the executing entire lines.
  122.  
  123.  
  124. Invoking ANARKEY Functions
  125. --------------------------
  126.    To execute an ANARKEY function from the command-line, ANARKMD must be
  127. told:
  128.  
  129.         (1) to execute an ANARKEY function and
  130.         (2) which function to execute
  131.  
  132.    Both of these pieces of information are provided to ANARKMD via
  133. command-line options.  Options always begin with a dash (-) character and
  134. may be in upper or lower case.  Options may be specified in any order.
  135.  
  136.    The supported options are:
  137.  
  138.    -Fx          -- ANARKEY function to execute
  139.  
  140.    The -F option is used to tell ANARKMD which ANARKEY function to execute.
  141.    Only one -F option per ANARKMD invocation is allowed.  If multiple -F
  142.    options are specified, only the last one will be recognized.
  143.  
  144.    The -F option is immediately followed by a full description of the
  145.    function to be executed.  No spaces may separate the -F option from the
  146.    function description.
  147.  
  148.    ANARKMD looks at only the first two characters of the description to
  149.    determine its identity, thus, you may abbreviate the function description
  150.    by only specifying its first two characters.  The function description
  151.    may be in upper or lower case.
  152.  
  153.    The supported functions are:
  154.  
  155.      o BOttom_display_history_buffer
  156.  
  157.         The contents of the history buffer are display onscreen starting
  158.         from the last line in the buffer and advancing to the first.  This
  159.         function executes the ANARKEY Display-History-Buffer-From-Bottom
  160.         function assigned to the <Ctrl-F4> key.
  161.  
  162.         Examples:
  163.                         >ANARKMD -FBottom_display_history_buffer
  164.                         >ANARKMD -FBO
  165.  
  166.      o CLear_history_buffer
  167.  
  168.         All lines stored in the history buffer will be removed.
  169.  
  170.         This function is identical to executing the ANARKEY Clear-History-
  171.         Buffer function assigned to the <Ctrl-X> key by default.
  172.  
  173.         Examples:
  174.                         >ANARKMD -Fclear_history_buffer
  175.                         >ANARKMD -fCL
  176.  
  177.      o DIsplay_history_buffer
  178.  
  179.         The contents of the history buffer will be displayed onscreen.  This
  180.         function invokes the ANARKEY Display-History-Buffer-Contents
  181.         operation mapped to the <F4> key.
  182.  
  183.         Examples:
  184.                         >ANARKMD -FDisplay_History_Buffer
  185.                         >ANARKMD -FDI
  186.  
  187.      o LIst_switchar_programs
  188.  
  189.         The contents of the UNIX switchar buffer will be displayed onscreen.
  190.         This operation executes the ANARKEY Display-Switchar-Programs
  191.         function mapped to <Shift-F4>.
  192.  
  193.         Examples:
  194.                         >ANARKMD -FList_Switchar_Programs
  195.                         >ANARKMD -FLI
  196.  
  197.      o REstore_anarkey
  198.  
  199.         Will restore ANARKEY input processing of DOS command lines.  Input
  200.         processing can be disabled by the SUspend_anarkey_input_processing
  201.         function.  Refer to the SUspend_anarkey_input_processing option's
  202.         description for further details.
  203.  
  204.         There is no comparable function available in ANARKEY.  Once
  205.         suspended, ANARKEY can only be restored by running ANARKMD with this
  206.         option.
  207.  
  208.         Examples:
  209.                         >ANARKMD -FRestore_anarkey
  210.                         >ANARKMD -FRE
  211.  
  212.      o SHow_AKAs
  213.  
  214.         The list of defined AKAs will be displayed onscreen, just as if you
  215.         had invoked the ANARKEY View-AKAs function by pressing the <Alt-F4>
  216.         key.
  217.  
  218.         Examples:
  219.                         >ANARKMD -Fshow_AKAs
  220.                         >ANARKMD -Fsh
  221.  
  222.      o SUspend_anarkey
  223.  
  224.         Will suspend ANARKEY handling of input commands.  All ANARKEY
  225.         features will be disabled indefinitely.  ANARKEY can be enabled
  226.         again by running ANARKMD with the REstore_anarkey option.
  227.  
  228.         There is no comparable function available in ANARKEY itself.
  229.  
  230.         Examples:
  231.                         >ANARKMD -FSuspend_Anarkey
  232.                         >ANARKMD -FSU
  233.  
  234.      o TOggle_input_mode
  235.  
  236.         The TOggleInputMode function will cause ANARKMD to execute the
  237.         ANARKEY Toggle-Insert/Overwrite-Mode function whose default key
  238.         assignment is the <Ins> key.
  239.  
  240.         Examples:
  241.                         >ANARKMD -Ftoggle_input_mode
  242.                         >ANARKMD -Fto
  243.  
  244.      o UNdefine_all_AKAs
  245.  
  246.         All AKAs will be undefined.  This is the same as pressing the
  247.         <Alt-X> key to invoke the ANARKEY Undefine-All-AKAs function.
  248.  
  249.         Examples:
  250.                         >ANARKMD -FUndefine_all_AKAs
  251.                         >ANARKMD -Fun
  252.  
  253.      o WRite_history_buffer:file_specification
  254.  
  255.         The contents of the history buffer are written to the
  256.         file_specification disk file.  "file_specification" is any valid DOS
  257.         filename, including an optional drive and/or path name.  There is
  258.         no default value for file_specification; it must always be
  259.         explicitly specified.  The file_specification is separated from the
  260.         function description by a colon (:).  No spaces may exist on either
  261.         side of the colon.
  262.  
  263.         This function executes the ANARKEY Write-History-Buffer-to-Disk
  264.         function normally assigned to <Ctrl-W>.
  265.  
  266.         Support for the file_specification provides a new capability not
  267.         found in the associated ANARKEY function.  ANARKEY will only write
  268.         the disk file to ANARKEY.LOG in the root directory of the current
  269.         drive.
  270.  
  271.         This capability can be very useful if you have a standard batch file
  272.         you run whenever you powerdown your machine.  You could add a line
  273.         to the batch file which saves the current history buffer and then
  274.         run LOAD from the AUTOEXEC file to restore the buffer the next time
  275.         you powerup.
  276.  
  277.         Examples:
  278.                         >ANARKMD -Fwr:e:\usr\dave\log\buffer.log
  279.                         >ANARKMD -Fwr:\log\savehist.buf
  280.                         >:whb anarkmd -fwr:c:\anarkey.log
  281.                         anarkmd -fwr:%1         <--- As in a batch file
  282.  
  283.  
  284.    -Pn          -- ANARKEY Process Number
  285.  
  286.    The -Pn option is used to inform ANARKMD of ANARKEY's installation
  287.    process number.  This option is identical to the -P option available on
  288.    the ANARKEY installation line.  Please refer to the "ANARKEY User Manual"
  289.    for details about when to use this option.
  290.  
  291.    The -P option will only be required in extremely rare instances.  If you
  292.    installed ANARKEY without it, you will not need to use it for ANARKMD
  293.    either.
  294.  
  295.    Examples:
  296.                         >ANARKMD -FToggle_Input_Mode -P14
  297.                         >ANARKMD -p3 -Fun
  298.  
  299.  
  300. Executing an Entire Input Line
  301. ------------------------------
  302.    As mentioned, ANARKMD can also be used to execute an entire input line.
  303. This capability is most useful when used in batch files as it allows you to
  304. execute multiple-command lines and AKAs within them.
  305.  
  306.    To have ANARKMD execute an input line, simple specify the line on the
  307. ANARKMD command line.  Any valid DOS input line may be entered.  If ANARKEY
  308. is installed, any valid ANARKEY input line is also allowable.  This means
  309. the line can contain multiple commands and AKAs and be up to 255 characters
  310. long.  The line will be executed just as if it had been entered at the DOS
  311. command prompt.
  312.  
  313.    Some sample command lines follow.
  314.  
  315.                 ANARKMD dir
  316.                 ANARKMD aka;edit file.x;aka2
  317.                 ANARKMD aka2 file1 file2 file3
  318.  
  319.    If the line contains DOS redirection characters >, >> or < or the pipe
  320. operator |, bracket the entire line with double quotes (").
  321.  
  322.                 ANARKMD "dir >dir.log"
  323.                 ANARKMD "aka file1 | more;aka2"
  324.  
  325.    As part of the process of executing a line, ANARKMD creates a temporary
  326. disk file.  By default, the file will be written to the current directory of
  327. the current drive.  The temporary file can be written somewhere else by
  328. defining an environment variable called "ANARTMP".  ANARTMP should be set to
  329. the drive and/or directory to which the temporary file should be written.
  330. The temporary file is always deleted before ANARKMD terminates.
  331.  
  332.    For example, the following environment variable definitions would
  333. instruct ANARKMD to store its temporary file in a specific location:
  334.  
  335.                 >SET ANARTMP=g:
  336.                 >SET ANARTMP=c:\temp\
  337.                 >SET ANARTMP=a:/etc
  338.  
  339.  
  340.  
  341.                           Comments and Suggestions
  342.                           ------------------------
  343.  
  344.    I would love to hear your suggestions, comments, and enhancement ideas
  345. concerning ANARKMD and the other programs in the ANARKEY software package.
  346. Please send your suggestions to:
  347.  
  348.                                 Steven Calwas
  349.                                Moderne Software
  350.                                 P.O. Box 3638
  351.                           Santa Clara, CA 95055-3638
  352.  
  353.                               _______
  354.                          ____|__     |               (tm)
  355.                       --|       |    |-------------------
  356.                         |   ____|__  |  Association of
  357.                         |  |       |_|  Shareware
  358.                         |__|   o   |    Professionals
  359.                       -----|   |   |---------------------
  360.                            |___|___|    MEMBER
  361.  
  362.